/*

    gl-web  Reusable web components.
    Copyright (c) 2012-2015 National Marrow Donor Program (NMDP)

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Lesser General Public License as published
    by the Free Software Foundation; either version 3 of the License, or (at
    your option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
    License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this library;  if not, write to the Free Software Foundation,
    Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.

    > http://www.fsf.org/licensing/licenses/lgpl.html
    > http://www.opensource.org/licenses/lgpl-license.php

*/
package org.immunogenomics.gl.web.dosfilter;

/**
 * MXBean for configuration of denial of service filter.
 */
public interface DenialOfServiceConfigMXBean {

    String toString();

    /**
     * Return the number of hits that are not restricted.
     */
    int getFreeHitCount();

    void setFreeHitCount(int freeHitCount);

    /**
     * Return maximum number of hits per minute for anonymous access.
     */
    int getAnonymousHitsPerMinute();

    void setAnonymousHitsPerMinute(int anonymousHitsPerMinute);

    long getCleanInterval();

    void setCleanInterval(long cleanInterval);

    void updateCleanIntervalInMinutes(String cleanIntervalMin) throws NumberFormatException;

    void updateFreeHitCount(String hitCountStr);

    void updateAnonymousHitsPerMinute(String hitCountStr);

    /**
     * Return the delay in milliseconds to wait before providing a response.
     */
    long getThrottleDelay();

    void setThrottleDelay(long throttleDelay);

    void updateThrottleDelay(String msString);
    
    /**
     * Returns the name of a request attribute that is required for authorized access. 
     * If present, the client is considered authorized.  
     * A separate SecurityFilter should actually test authorization and set the attribute.
     */
    String getAuthorizationAttribName();

}